docs(run-a-relay): document relay operator config knobs (14 locales) - #45
Merged
Conversation
Add a "Configuration and tuning" section to the run-a-relay page documenting every dig-relay tunable: network listeners, capacity/connection limits, the per-IP/per-connection abuse-protection limits, health-sweep/liveness knobs, and optional relay-side TLS. Each entry gives the CLI flag, the DIG_RELAY_* env var, the default, and what it does. Applied byte-identically to all 14 locales (English mirrors per repo convention). Values verified against dig-relay v0.12.0. Co-Authored-By: Claude <noreply@anthropic.com>
MichaelTaylor3d
commented
Jul 21, 2026
MichaelTaylor3d
left a comment
MichaelTaylor3d
left a comment
Contributor
Author
There was a problem hiding this comment.
PASS — independent correctness/quality review (docs-only, single leg).
Verified every knob row against the dig-relay source of truth (main.rs clap flags + service.rs config_from_env + SPEC §7):
- All CLI flag names, DIG_RELAY_* env var names, and defaults match exactly.
- idle-timeout-secs correctly shown as (flag only) — no DIG_RELAY_IDLE_* env var exists in config_from_env.
- Byte defaults 262144 (256 KiB) / 1048576 (1 MiB/s) / 1073741824 (1 GiB) and the 0-disables annotations are accurate; listeners default to [::] dual-stack.
- Section present + byte-identical across all 14 files (English + 13 locale mirrors; md5 008dcae6… on every one).
- Docs hygiene clean: no internal-file refs / issue numbers / per-§ prose; operator-oriented positive voice; relative links (./universal-installer.md, ./configure.md) resolve to existing pages.
- Version bumped 0.5.1 -> 0.5.2.
No findings. Merge unblocked on this leg.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds an operator Configuration and tuning section to the Run a relay page — the page previously documented no relay config knobs at all. Documents every
dig-relaytunable (v0.12.0): network listeners, capacity/connection limits, per-IP + per-connection abuse-protection limits, the health-sweep/liveness pruning knobs, and optional relay-side TLS termination. Each entry lists its CLI flag,DIG_RELAY_*environment variable, default value, and a one-line description; abuse limits note that0disables them.Applied byte-identically across all 14 locales (1 English + 13 i18n mirrors — this page follows the repo's English-mirror convention).
How verified
dig-relayv0.12.0 config surface and cross-checked against its config, CLI, and service-env sources.## Configuration and tuningpresent exactly once in each of the 14 files.0.5.1→0.5.2(patch: docs-only addition, no behaviour change).docusaurus build+ a11y/SEO suite (broken-link/anchor throw) must pass.Refs
Docs coherence for DIG-Network/dig_ecosystem#1403; siblings DIG-Network/dig_ecosystem#1386 (abuse limits) and DIG-Network/dig_ecosystem#1382 (health sweep).